Class PasswdUserDBAuthentication
java.lang.Object
org.dogtagpki.server.authentication.AuthManager
com.netscape.cmscore.authentication.PasswdUserDBAuthentication
Certificate Server admin authentication.
Used to authenticate administrators in the Certificate Server Console.
Authentications by checking the uid and password against the
database.
- Author:
- lhsiao, cfu
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
static final String
static org.slf4j.Logger
protected static String[]
static final String
static final String
Fields inherited from class org.dogtagpki.server.authentication.AuthManager
AUTHENTICATED_NAME, authenticationConfig, CRED_CERT_SERIAL_TO_REVOKE, CRED_CMC_SELF_SIGNED, CRED_CMC_SIGNING_CERT, CRED_HOST_NAME, CRED_SESSION_ID, CRED_SSL_CLIENT_CERT, engine, mConfig, mConfigParams, mImplName, mName
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionauthenticate
(AuthCredentials authCred) authenticates administratrators by LDAP uid/pwdString[]
get the list of authentication credential attribute names required by this authentication manager.Retrieves the localizable description of this policy.getValueDescriptor
(Locale locale, String name) Retrieves the descriptor of the given value property by name.Retrieves a list of names of the property.void
init
(ConfigStore config) Initializes this default policy.void
init
(AuthenticationConfig authenticationConfig, String name, String implName, AuthManagerConfig config) initializes the PasswdUserDBAuthentication auth managerboolean
Checks if this authenticator requires SSL client authentication.boolean
isValueWriteable
(String name) Checks if the value of the given property should be serializable into the request.void
Populates authentication specific information into the request for auditing purposes.void
shutdown()
disconnects the member connectionMethods inherited from class org.dogtagpki.server.authentication.AuthManager
getAuthenticationConfig, getCMSEngine, getConfigParams, getConfigStore, getImplName, getName, getName, setAuthenticationConfig, setCMSEngine
-
Field Details
-
logger
public static org.slf4j.Logger logger -
CRED_UID
- See Also:
-
CRED_PWD
- See Also:
-
TOKEN_USERDN
- See Also:
-
TOKEN_USERID
- See Also:
-
mRequiredCred
-
-
Constructor Details
-
PasswdUserDBAuthentication
public PasswdUserDBAuthentication()
-
-
Method Details
-
init
public void init(AuthenticationConfig authenticationConfig, String name, String implName, AuthManagerConfig config) throws EBaseException initializes the PasswdUserDBAuthentication auth managercalled by AuthSubsystem init() method, when initializing all available authentication managers.
- Specified by:
init
in classAuthManager
- Parameters:
name
- - Name assigned to this authentication manager instance.implName
- - Name of the authentication plugin.config
- - The configuration store used by the authentication subsystem.- Throws:
EBaseException
- If an initialization error occurred.
-
init
Description copied from class:AuthManager
Initializes this default policy.- Specified by:
init
in classAuthManager
- Parameters:
config
- configuration store- Throws:
EProfileException
- failed to initialize
-
authenticate
public AuthToken authenticate(AuthCredentials authCred) throws EMissingCredential, EInvalidCredentials, EBaseException authenticates administratrators by LDAP uid/pwdcalled by other subsystems or their servlets to authenticate administrators
- Specified by:
authenticate
in classAuthManager
- Parameters:
authCred
- Authentication credentials. "uid" and "pwd" are required.- Returns:
- the authentication token (authToken) that contains the following
userdn = [userdn, in case of success]
authMgrName = [authMgrName]
-
populate
Description copied from class:AuthManager
Populates authentication specific information into the request for auditing purposes.- Specified by:
populate
in classAuthManager
- Parameters:
token
- authentication tokenrequest
- request- Throws:
EProfileException
- failed to populate
-
getText
Description copied from class:AuthManager
Retrieves the localizable description of this policy.- Specified by:
getText
in classAuthManager
- Parameters:
locale
- end user locale- Returns:
- localized authenticator description
-
getValueNames
Description copied from class:AuthManager
Retrieves a list of names of the property.- Specified by:
getValueNames
in classAuthManager
- Returns:
- a list of property names
-
getValueDescriptor
Description copied from class:AuthManager
Retrieves the descriptor of the given value property by name.- Specified by:
getValueDescriptor
in classAuthManager
- Parameters:
locale
- user localename
- property name- Returns:
- descriptor of the requested property
-
isValueWriteable
Description copied from class:AuthManager
Checks if the value of the given property should be serializable into the request. Passsword or other security-related value may not be desirable for storage.- Specified by:
isValueWriteable
in classAuthManager
- Parameters:
name
- property name- Returns:
- true if the property is not security related
-
isSSLClientRequired
public boolean isSSLClientRequired()Description copied from class:AuthManager
Checks if this authenticator requires SSL client authentication.- Specified by:
isSSLClientRequired
in classAuthManager
- Returns:
- client authentication required or not
-
getRequiredCreds
get the list of authentication credential attribute names required by this authentication manager. Generally used by servlets that use this authentication manager, to retrieve required credentials from the user (e.g. Javascript form data)- Specified by:
getRequiredCreds
in classAuthManager
- Returns:
- attribute names in Vector
-
shutdown
public void shutdown()disconnects the member connection- Specified by:
shutdown
in classAuthManager
-